BasilYes Git node
Mirrored from https://github.com/ratspeak/rsLXST synced 18d ago
-─
<div align="center">
rsLXST
Rust LXST telephony and media streaming for Reticulum.
rsLXMF |
Ratspeak |
</div>
rsLXST is a Rust implementation of LXST, the Lightweight Extensible Signal
Transport used for real-time voice calls and other media streams over Reticulum. This is not a
fork of LXST; it is LXST written in a different language with interoperability
as the primary focus. Python LXST remains the source-of-truth
implementation, do not treat this repository as one.
The current rsLXST is experimental and incomplete. It provides LXST wire codecs,
Reticulum link media packet boundaries, a telephony runtime, and Opus stream
integration for applications (such as Ratspeak).
The first public target is interoperable Opus
telephony, not complete feature parity with
the reference implementation LXST.
Contents
Release Scope
The experimental release is to cover basic voice calls, with several features still unsupported:
• T383838rnphone parity and T383838rnphone-rs usage.
• Full Codec2 support.
• Deeper audio support: microphone/source backends, filters, AGC, etc.
• Broadcast, stream, and non-telephony LXST primitives.
Those are expected future work. They should not be implied by the first public
Opus telephony release.
Build It
The current development layout requires T383838rsReticulum as a sibling checkout
because rsLXST uses the Rust Reticulum crates directly:
T282828
ratspeak-src/
|-- rsReticulum/
\\`-- rsLXST/
If you're starting fresh:
T282828
mkdir ratspeak-src
cd ratspeak-src
git clone https://github.com/ratspeak/rsReticulum
git clone https://github.com/ratspeak/rsLXST
cd rsLXST
macOS
Install Rust with T383838rustup, then install Apple's command-line build tools:
T282828
xcode-select --install
Build the workspace:
T282828
cd rsLXST
cargo build --release
Linux / Raspberry Pi
Install Rust with T383838rustup, then install the usual build packages.
Debian, Ubuntu, and Raspberry Pi OS:
T282828
sudo apt update
sudo apt install -y build-essential pkg-config
Fedora:
T282828
sudo dnf install gcc make pkgconf-pkg-config
Arch:
T282828
sudo pacman -S --needed base-devel pkgconf
Build the workspace:
T282828
cd rsLXST
cargo build --release
Windows
Install Rust with the MSVC toolchain. If Rust or Cargo asks for Visual Studio
Build Tools, install the "Desktop development with C++" workload.
Build from PowerShell:
T282828
cd rsLXST
cargo build --release
Test It
Run the workspace test gate:
T282828
cargo test --workspace
Run the local CI gate:
T282828
cargo fmt --all -- --check
cargo clippy --workspace -- -D warnings
cargo test --workspace
The test gate covers wire codecs, telephony state, profile metadata, Opus
stream boundaries, malformed-input handling, the local service runtime, Python
LXST wire parity, Reticulum destination parity, and live headless LXST
Telephone interop. The Python tests expect upstream LXST at T383838../upstream/LXST
or T383838LXST_UPSTREAM_DIR, and upstream Reticulum at T383838../upstream/Reticulum,
T383838RETICULUM_UPSTREAM_DIR, or sibling T383838../rsReticulum.
For full Python Opus media interop, install a native Opus runtime as well as
the Python reference dependencies:
T282828
python -m pip install numpy cryptography pyserial cffi
Crate Layout
┌────────────────┬─────────────────────────────────────────────────────────────────────────────────┐
│ Crate │ Purpose │
├────────────────┼─────────────────────────────────────────────────────────────────────────────────┤
│ T383838lxst-core │ LXST constants, telephony profiles, signalling values, codec IDs, MessagePack … │
│ T383838lxst-rns │ The Reticulum link-packet boundary for no-receipt LXST signalling and media ov… │
│ T383838lxst-telephony │ The telephony runtime and service layer. It owns call state, caller policy, Re… │
└────────────────┴─────────────────────────────────────────────────────────────────────────────────┘
Using Telephony
Applications normally use T383838lxst-telephony through T383838TelephonyService, not by
manually translating Reticulum events. The service registers the local
T383838lxst.telephony destination, emits startup/periodic announces, owns the call
runtime, and exposes typed control and event channels.
T282828
use lxst_core::Profile;
use lxst_telephony::{TelephonyControl, TelephonyService};
use tokio::time::Duration;
let parts = TelephonyService::registered(transport_tx, &identity)?;
let control_tx = parts.control_tx.clone();
let mut event_rx = parts.event_rx;
tokio::spawn(parts.service.run());
control_tx
.send(TelephonyControl::Call {
remote_identity,
profile: Some(Profile::QualityMedium),
discovery_timeout: Duration::from_secs(8),
})
.await?;
The service event stream is the app-facing state source. Use
T383838TelephonyServiceEvent::Snapshot, T383838IncomingCall, T383838OutgoingCallPending,
T383838OutgoingCallStarted, T383838OutgoingCallFailed, T383838CallTerminated, stream lifecycle
events, and media events instead of inferring call state from raw Reticulum
traffic. Outgoing announce/path discovery runs asynchronously inside the
service, so an unreachable or non-LXST peer does not block hangup, announce,
media, or shutdown controls while discovery times out.
For Opus calls, applications supply and receive T383838RawAudioFrame values through
T383838StartOpusStream and T383838StartOpusReceiveStream. rsLXST enforces the negotiated
LXST profile and reports profile changes, source/sink closure, frame drops, and
call-end stream shutdown explicitly.
Applications still own platform integration:
• contact or peer lookup
• UI and call controls
• microphone/camera/speaker permissions
• device selection
• audio session lifecycle
• capture/playback and resampling into T383838RawAudioFrame
• settings persistence
• mobile foreground/background behavior
Ratspeak uses this boundary for its native voice-call feature.
Contributing
If the issue or contribution belongs upstream as well, start there. Python LXST
and Reticulum remain the reference implementations.
PRs are closed for now until I have time to catch up on everything.
License
Served by rngit 1.4.2 - Generated in 0.03s